<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
    <title>Jumper</title>
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>

<div id="container">

<div id="product">
	<div id="product_logo"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->


<div id="main">


<!-- Menu -->

<div id="navigation">
<br/>
<h1>Jumper</h1>

<ul>
  <li><a href="../index.html">Index</a></li>
</ul>



<h2>Scripts</h2>
<ul>
  <li><strong>init</strong></li>
  <li><a href="../scripts/jumper.html">jumper</a></li>
</ul>
<h2>Modules</h2>
<ul>
  <li><a href="../modules/core.bheap.html">core.bheap</a></li>
  <li><a href="../modules/core.grid.html">core.grid</a></li>
  <li><a href="../modules/core.heuristics.html">core.heuristics</a></li>
  <li><a href="../modules/core.node.html">core.node</a></li>
</ul>

</div>

<div id="content">

<h1>Script <code>init</code></h1>

<p><strong>The init hook file</strong>.</p>
<p> The default way to import Jumper in your project is the following:
 <ul>
 <pre class="example">
 local Jumper = require (&quot;Jumper.init&quot;)
 </pre></ul></p>

<p> The call to <code>init.lua</code> was meant for package self-containment purposes.
 On some Lua distributions, the package of modules contains the pattern <code>init.lua</code>.
 In this case, to import the library in your project, you can just write the following:
 <ul>
 <pre class="example">
 local Jumper = require (&quot;Jumper&quot;)
 </pre></ul></p>

<p> Optionnally, you can also add the pattern <code>init.lua</code> in your package of modules.
 Therefore, the syntax can be shortened:
 <ul>
 <pre class="example">
 package.path = package.path .. (&quot;;.\\?\\init.lua&quot;)
 local Jumper = require (&quot;Jumper&quot;)
 </pre></ul></p>
    <h3>Info:</h3>
    <ul>
        <li><strong>Copyright</strong>: 2012-2013</li>
        <li><strong>License</strong>: <a href="http://www.opensource.org/licenses/mit-license.php">MIT</a></li>
        <li><strong>Author</strong>: Roland Yonaba</li>
    </ul>



<br/>
<br/>




</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.3</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
